<!--
  ~ Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
  ~
  ~ This program is free software; you can redistribute it and/or modify it
  ~ under the terms of the GNU General Public License as published by the Free
  ~ Software Foundation; either version 3 of the License, or (at your option)
  ~ any later version.
  ~ This program is distributed in the hope that it will be useful, but WITHOUT
  ~ ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  ~ FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  ~ more details.
  ~
  ~ You should have received a copy of the GNU General Public License along
  ~ with this program; if not, see http://www.gnu.org/licenses/
  -->

<html>
<head>
    <title>SNAP Data Processors - C2RCC Processor Description</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    <link rel="stylesheet" href="../style.css">
</head>

<body>
<table class="header">
    <tr class="header">
        <td class="header">C2RCC Processor Description</td>
        <td class="header" align="right"><a href="nbdocs://org.esa.snap.snap.help/org/esa/snap/snap/help/docs/general/overview/SnapOverview.html"><img
                src="../images/snap_header.jpg"
                border=0></a>
        </td>
    </tr>
</table>

<h3>User Interface</h3>

<p>The user interface of all C2RCC processors consist of the <a href="#menu_header">menu</a> and the lower <a href="#button_group_header">button
    group</a>, they are common to all sensor specific procesors. The <a href="C2RCCIOParameters.html">I/O Parameters</a> are common for all
    processors too.<br></p>
<p>MODIS needs special L1C data. The processing level can be generated with SeaDAS. It is briefly described here: <a href="Create_MODIS_L1C.html">Create
        MODIS L1C</a> <br>
    The Processing Parameters are sensor specific and are described on the following pages:
</p>
<ul>
    <li><a href="C2RCC_OLCI_ProcParameters.html"> OLCI Parameters</a></li>
    <li><a href="C2RCC_S2MSI_ProcParameters.html"> S2-MSI Parameters</a></li>
    <li><a href="C2RCC_L8_ProcParameters.html"> Landsat-8 Parameters</a></li>
    <li><a href="C2RCC_MERIS_ProcParameters.html"> MERIS Parameters</a></li>
    <li><a href="C2RCC_MERIS4_ProcParameters.html"> MERIS 4th-Reprocessing Parameters</a></li>
    <li><a href="C2RCC_MODIS_ProcParameters.html"> MODIS Parameters</a></li>
    <li><a href="C2RCC_SEAWIFS_ProcParameters.html"> SeaWiFS Parameters</a></li>
    <li><a href="C2RCC_VIIRS_ProcParameters.html"> VIIRS Parameters</a></li>
</ul>
<p>Beside the graphical user interface, C2RCC processors can also be used from the <a href="#command_line">command line</a>.</p>

<a name="menu_header"><h4>Menu</h4></a>
<h5>File</h5>

<b>Open Parameters...:</b><br>
<p>When this entry is selected, an 'Open File' dialog will appear. Here, a GPF parameters XML file can be selected, containing processing parameters
    for this processor which were saved earlier. These parameters will be loaded and applied for the upcoming processing.</p>

<b>Save Parameters...:</b><br>
<p>When this entry is selected, a 'Save File' dialog will appear. Here, the current set of processing parameters can be saved into a
    GPF parameters XML file for later use.</p>

<b>Display Parameters...:</b><br>
<p>When this entry is selected, the current set of processing parameters will be displayed in XML format. Can be used to copy the
    parameters into an existing GPF graph XML file.</p>

<h5>Help</h5>
<b>Help:</b>
<p>When this entry is selected, this online help for this processor is opened in a separate window.</p>
<b>About...:</b>
<p>When this entry is selected, an 'About' dialog for the current processor is opened.</p>

<a name="button_group_header"><h4>Button Group</h4></a>

<b>Run:</b><br>
<p>When this button is clicked, the processing will be started with the selected parameters.</p>

<b>Close:</b><br>
<p>When this button is clicked, the processor tool window will be closed.</p>

<a name="command_line"><h4>Command Line</h4></a>
<p>The C2RCC is implemented as an operator for the <a href="nbdocs://org.esa.snap.snap.gpf.ui/org/esa/snap/core/gpf/docs/gpf/GpfOverview.html">Graph
    Processing Framework (GPF)</a>. Therefore it can be used also with the 'gpt' command line tool
    outside SNAP Desktop. The processing is invoked by the command</p>
<p style="font-family: monospace; text-indent: 3em">${SNAP-INSTALL-DIR}/bin/gpt</p>
<p>To obtain general help on the graph processing, use the command</p>
<p style="font-family: monospace; text-indent: 3em">${SNAP-INSTALL-DIR}/bin/gpt -h</p>
<img src="images/cmd/C2RCC_CMD_OpList.png"/>
<p>All names of the operators are listed, including the C2RCC operators. All C2RCC operators start with the prefix 'c2rcc.'
</p>
<p>Specific help on each of the operators can be obtained with</p>
<p style="font-family: monospace; text-indent: 3em">${SNAP-INSTALL-DIR}/bin/gpt -h c2rcc.&lt;sensor_name&gt;</p>
<p>Information on the usage and a list of all available parameters are given.</p>
<img src="images/cmd/C2RCC_CMD_HelpDump.png"/>
<p>This will also print a XML template which you can you use to build a graph XML file. This is useful when you want to perform multiple steps in one
    go or if you want to persist the parameters and don't want to specify them every time on the command line.</p>
<p>Such a graph file can the be called as follows:</p>
<p style="font-family: monospace; text-indent: 3em">${SNAP-INSTALL-DIR}/bin/gpt graphFile.xml &lt;sourceFilePath&gt;</p>
<hr>
</body>
</html>
